home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / bkla105.arc / BINKLA.DOC next >
Text File  |  1991-09-27  |  19KB  |  405 lines
  1.  
  2.                               BinkLA Version 1.05
  3.                               September 23nd, 1991
  4.  
  5.     ╔═══════════════════════╤═════════════════════╤═══════════════════════╗
  6.     ║▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓│ BinkLA Version 1.05 │▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓║
  7.     ╠═══════════════════════╧═════════════════════╧═══════════════════════╣
  8.     ║                    Binkley Log Level 5 Analyzer                     ║
  9.     ║       Copyright (C) 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED   ║
  10.     ║              SysOp of RJ's Byteline BBS - FidoNet 1:134/75          ║
  11.     ╙─────────────────────────────────────────────────────────────────────╜
  12.                                      - 1 -
  13.  
  14.                        ──────── What Is BinkLA ────────
  15.  
  16.     BinkLA is a program I wrote to look at  the  Binkley  Log  file.   It's
  17.     prime  purpose  is  to  summarize  output  on  Network  activity.   The
  18.     information reported is obtained from string information contained in a
  19.     BinkleyTerm log file.
  20.  
  21.  
  22.                        ──────── Acknowledgement ───────
  23.  
  24.     BinkleyTerm is Copyright by Robert Hartman and Vincent Perriello. QSort
  25.     if Copyright by Ben Baker.  I claim no credit  for  any  part  of  this
  26.     fine software.  I hope my BinkLA program will compliment BinkleyTerm by
  27.     summarizing the log entries.
  28.  
  29.  
  30.                        ────────── Why BinkLA ──────────
  31.  
  32.     I  wrote BinkLA for my own use when I was humping and Hubing mail/files
  33.     around Fido Net 1:163.  I found it gave a great view of what was  going
  34.     on  in  my  system.  Other SysOps in Net 1:163 expressed interest. I've
  35.     been making progressive improvements ever since.   The  first  official
  36.     release of BinkLA (Version 1.00) was distributed by SDS in early March,
  37.     1990.
  38.  
  39.  
  40.                        ────── Where to Put BinkLA ─────
  41.  
  42.     I  recommend  that  BinkLA reside in the same directory as your Binkley
  43.     executables and log file however this is not a  mandatory  requirement.
  44.     Some other points:
  45.  
  46.          (2) The Binkley log file may be called any valid DOS file name and
  47.              may reside in any directory.  Please see "How to  Run  BinkLA"
  48.              on the next page.  LogLevel must be set at  five  (5)  in  the
  49.              Binkley.Cfg file to obtain accurate results.
  50.  
  51.          (3) Either QSort or the DOS Sort.Exe utility MUST be available  on
  52.              your  path or reside in that same directory that BinkLA is run
  53.              from. BinkLA will look for QSort as a default.  If it does not
  54.              find  QSort  on  your path or home directory it will fall back
  55.              to  using  DOS  Sort.Exe.   I  highly recommend using QSort as
  56.              it's a lot faster and uses a less memory to sort.
  57.  
  58.  
  59.  
  60.  
  61.     ╔═══════════════════════╤═════════════════════╤═══════════════════════╗
  62.     ║▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓│ BinkLA Version 1.05 │▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓║
  63.     ╠═══════════════════════╧═════════════════════╧═══════════════════════╣
  64.     ║                    Binkley Log Level 5 Analyzer                     ║
  65.     ║       Copyright (C) 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED   ║
  66.     ║              SysOp of RJ's Byteline BBS - FidoNet 1:134/75          ║
  67.     ╙─────────────────────────────────────────────────────────────────────╜
  68.                                      - 2 -
  69.  
  70.                        ────── When to run BinkLA ──────
  71.  
  72.     You can run BinkLA several times a day if you like.  One very good time
  73.     to  run  it  would be during a  daily maintenance event.  I suggest you
  74.     start a new Binkley.log every 24 hours.  I  append  BKLARPT.TXT  to  my
  75.     Binkley.log file just before I run my nightly SavLogs program.
  76.  
  77.  
  78.                        ─────── How to run BinkLA ──────
  79.  
  80.     Use:
  81.  
  82.     BINKLA [<-switch> <LOG=log filename>] or
  83.     BINKLA [@filename[.rsp]]
  84.  
  85.     All  switches  are  optional as is the log filename and may be given in
  86.     any order. If no Command Line parameters are given BinkLA. Defaults  to
  87.     creating BKLARPT.TXT and uses Binkley.log in the default directory.
  88.  
  89.     Switches:
  90.  
  91.              No switch will use the default log called Binkley.log, produce
  92.              Bklarpt.txt and exit BinkLA
  93.  
  94.       -BBS   Will  produce  file BKLARPT.BBS, an Ansi colourized version of
  95.              BKLARPT.TXT suitable for display on a BBS  system.   The  file
  96.              contains   a  clear  screen  (ASCII  Value 12) and more prompt
  97.              (ASCII Value 5) code at the beginning of the file.  This works
  98.              well  with  my  Maximus  BBS setup.  I don't know  what affect
  99.              it  will  have on other BBS systems.  Use and 'Kludge' at your
  100.              own discretion.  If you use Maximus using Video  IBM,  Maximus
  101.              will  display the raw ANSI codes on the local screen but users
  102.              won't see them.
  103.  
  104.       -D     Optional -Ddrive:\path\filename.ext will produce a  data  file
  105.              from the data gathered to produce Part I of the BinkLA  report
  106.              The  fields  are  delimited  by   commas   (,).    The   field
  107.              descriptions   are:   Zone,  Net,  Node,  Calls_Out,  Connect,
  108.              Calls_In,  Msg_Bytes_Outgoing,  Msg_Bytes_Incoming,   CPS_Avg,
  109.              Transfer_Seconds.   If  no  Zone information is available, the
  110.              Zone field will be padded as 99. If no filename is given  with
  111.              the -D switch, the default filename will be Bklarpt.Dat.
  112.  
  113.       -EX.   Suppress    filenames   (-EX.Ext.Ext.Ext)   in   Part  II   of
  114.              Bklarpt.txt or .bbs.  Example:   Binkla  -EX.TIC.RSP.REQ  will
  115.              suppress  all incoming/outgoing filenames with an extension of
  116.              TIC, RSP or REQ.  A Maximum of 10 .Ext parameters may be  used
  117.              with the -EX switch.
  118.  
  119.       -H     A brief help screen.
  120.  
  121.  
  122.  
  123.  
  124.  
  125.     ╔═══════════════════════╤═════════════════════╤═══════════════════════╗
  126.     ║▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓│ BinkLA Version 1.05 │▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓║
  127.     ╠═══════════════════════╧═════════════════════╧═══════════════════════╣
  128.     ║                    Binkley Log Level 5 Analyzer                     ║
  129.     ║       Copyright (C) 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED   ║
  130.     ║             SysOp of RJ's Byteline BBS - FidoNet 1:134/75           ║
  131.     ╙─────────────────────────────────────────────────────────────────────╜
  132.                                      - 3 -
  133.  
  134.       -L     Will  cause  BinkLA  to  read  the  Binkley  log file entries,
  135.              produce text file BKLARPT.TXT and display the  output  to  the
  136.              screen using a list procedure.  The list procedure allows full
  137.              forward/backward scroll, Pg Up, Pg  Dn,  End,  Esc,  Home  and
  138.              eXit.  A maximum of 225 report output text lines are supported
  139.              by the list procedure.
  140.  
  141.       -LL    If file BKLARPT.TXT exists in  the default  directory,  BinkLA
  142.              will  immediately  jump  to the list procedure and display the
  143.              last  created  BKLARPT.TXT.   Note:  if any other command line
  144.              switches are given with the -LL switch, they will be ignored.
  145.  
  146.       -NZ    Will  suppress  Zone information  and only display Net/Node in
  147.              Bklarpt.  This should make Binkla 1.04  and  above  compatible
  148.              with BinkleyTerm Version 2.30
  149.  
  150.       LOG=   Log=[path\]filename  may  be  used  to  read a  Binkley.log in
  151.              another directory and/or a  logfile  not  called  the  default
  152.              "Binkley.log".
  153.  
  154.       @      @filename[.rsp] may be used instead of using the  switches  on
  155.              the  Command  line.   The response file must be in text format
  156.              and  have  an  extension  of ".RSP". When calling the response
  157.              file from the command line the extension  may  be  omitted  as
  158.              .RSP  is  assumed.  ie: BINKLA @BLA1 would look in the current
  159.              directory for a file  called  BLA1.RSP.  The  purpose  of  the
  160.              response  file  is  to  make it easier to execute BinkLA using
  161.              multiple switches. For example instead  of  -  BINKLA  -L  -NZ
  162.              -EX.TIC.REQ  LOG=System.log  which  is  quite cumbersome to type
  163.              from the command  line  you  can  create  a  plain  text  file
  164.              containing the command line parameters.  BinkLA only reads the
  165.              first  line of the of the response file so you may include any
  166.              remarks on subsequent lines if you like.
  167.  
  168.                        ─────── Explanatory Notes ──────
  169.  
  170.     Log File Strings.
  171.  
  172.     BinkLA uses the following strings found in a Binkley log file:
  173.  
  174.         " Timeout"
  175.         "BINK  Too many errors"
  176.         "BINK begin"
  177.         "BINK Connect 1200"
  178.         "BINK Connect 2400"
  179.         "BINK Connect 9600"
  180.         "BINK CPS:"
  181.         "BINK Disconnecting nuisance"
  182.         "BINK End of connection attempt"
  183.         "BINK End of FTS-000"
  184.         "BINK End of WaZOO"
  185.         "BINK end,"
  186.         "BINK Exiting to BBS"
  187.  
  188.  
  189.     ╔═══════════════════════╤═════════════════════╤═══════════════════════╗
  190.     ║▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓│ BinkLA Version 1.05 │▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓║
  191.     ╠═══════════════════════╧═════════════════════╧═══════════════════════╣
  192.     ║                    Binkley Log Level 5 Analyzer                     ║
  193.     ║       Copyright (C) 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED   ║
  194.     ║             SysOp of RJ's Byteline BBS - FidoNet 1:134/75           ║
  195.     ╙─────────────────────────────────────────────────────────────────────╜
  196.                                      - 4 -
  197.         "BINK Inbound"
  198.         "BINK Incoming cal"
  199.         "BINK Incoming call, dial aborted"
  200.         "BINK No Send"
  201.         "BINK Nobody answered"
  202.         "BINK Nothing to send"
  203.         "BINK Password override for outgoing call"
  204.         "BINK Processing node"
  205.         "BINK Pwd Err"
  206.         "BINK Password Err"
  207.         "BINK Received"
  208.         "BINK Remote didn't respond
  209.         "BINK Resuming from offset"
  210.         "BINK Session with"
  211.         "BINK Synchronizing to Offset"
  212.         "BINK Spawning BBS"
  213.         "BINK Z-rz  Too many errors"
  214.         "BINK Z-rz ???"
  215.         "Ring"
  216.         "SpawnBBS"
  217.  
  218.     If  any  of  these strings are changed in the Binkley.lng file, chances
  219.     are that BinkLA will run with erroneous results.
  220.  
  221.     System Name.
  222.  
  223.     If  BinkLA  finds  a Binkley.Cfg file in the default directory, it will
  224.     parse the Binkley.Cfg file looking for the "System"  verb  and  display
  225.     the  BBS  name  of  the System at the top (center) of the BinkLA report
  226.     (BKLARPT.TXT).
  227.  
  228.  
  229.     Time periods.
  230.  
  231.     BinkLA gets it's start time period  from  the  first  begin  statement.
  232.     Ending  time  comes  from  the  last  end  statement.  Version 1.00 was
  233.     dependent on a begin statement from the log file.
  234.  
  235.     I  was informed that Point operation of Binkley without a Nodelist does
  236.     not produce a begin statement in the log.  Begin  statement  dependence
  237.     has  been  removed from Version 1.01.  If BinkLA does not find it or an
  238.     end time it will create a pseudo time and continue processing.
  239.  
  240.     Telephone Calls (Part I).
  241.  
  242.     Telephone  calls where a file transfer occurs are not tabulated in Part
  243.     I.  Unsuccessful connect attempts will tabulate in Part I  even  though
  244.     the attempt might be to send a file.
  245.  
  246.     Transfer Minutes (Part I).
  247.  
  248.     Transfer minutes is based on the the formula (Bytes Transferred /  CPS)
  249.     / 60 rounded for output to one decimal point accuracy.
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.     ╔═══════════════════════╤═════════════════════╤═══════════════════════╗
  257.     ║▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓│ BinkLA Version 1.05 │▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓║
  258.     ╠═══════════════════════╧═════════════════════╧═══════════════════════╣
  259.     ║                    Binkley Log Level 5 Analyzer                     ║
  260.     ║       Copyright (C) 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED   ║
  261.     ║             SysOp of RJ's Byteline BBS - FidoNet 1:134/75           ║
  262.     ╙─────────────────────────────────────────────────────────────────────╜
  263.                                      - 5 -
  264.     Average CPS (Part I).
  265.  
  266.     Average  CPS is calculated by dividing the transfer time (seconds) into
  267.     the total number of bytes transferred.
  268.  
  269.     CPS Rate (Part II).
  270.  
  271.     The CPS rate is the actual rate shown in the Log.  The Total column CPS
  272.     Rate is an average of the of the total CPS Rate / File Transfers.
  273.  
  274.     Totals (Part II).
  275.  
  276.     The  totals in Part II are:
  277.  
  278.                 (1) The total number of files transferred.
  279.                 (2) Total bytes sent.
  280.                 (3) Total bytes received.
  281.                 (4) An average CPS transfer rate.
  282.                 (5) Total transfer minutes.
  283.  
  284.     Part  III  will  report  Network  Session  Costs  if the information is
  285.     available in the log file.  BinkleyTerm Version 2.50 now reports  these
  286.     costs  in  the  log file.  Only Session costs where the cost is greater
  287.     than $0.00 will be reported in Part III of the BinkLA report.
  288.  
  289.     Unsuccessful Connect Attempts (Part IV)
  290.  
  291.     Unsuccessful Connect Attempts are  (Calls  Out  plus  Calls  In)  minus
  292.     connects.
  293.  
  294.  
  295.  
  296.  
  297.     ╔═══════════════════════╤═════════════════════╤═══════════════════════╗
  298.     ║▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓│ BinkLA Version 1.05 │▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓║
  299.     ╠═══════════════════════╧═════════════════════╧═══════════════════════╣
  300.     ║                    Binkley Log Level 5 Analyzer                     ║
  301.     ║       Copyright (C) 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED   ║
  302.     ║             SysOp of RJ's Byteline BBS - FidoNet 1:134/75           ║
  303.     ╙─────────────────────────────────────────────────────────────────────╜
  304.                                      - 6 -
  305.  
  306.                        ─────────── Conclusion ─────────
  307.  
  308.     BinkLA is supplied as is.  Users are granted unlimited free license for
  309.     it's  use.  It's my small donation to the BBS community and hobby.
  310.  
  311.     I  would  be very pleased if you took the time to to try BinkLA on your
  312.     system.  I've had some very good vibes from  Sysops  around  the  world
  313.     using  BinkLA  and  I'm pleased that I am able to dedicate a worthwhile
  314.     program freely given in the same spirit as BinkleyTerm.
  315.  
  316.     One thing I would very much appreciate  is  if  you  would  send  me  a
  317.     NetMail  message  to  FidoNet  1:134/75  to  let me know if you use the
  318.     program.  I have a world map on my wall and I would very much  like  to
  319.     stick  a  few  map pins in it to indicate BBS friends from other places
  320.     who are using my program. Or you can drop me a Post Card via Snail Mail
  321.     to:
  322.  
  323.                                 R.J. (Bob) Ross
  324.                           #107A 3730 50th Street N.W.
  325.                            Calgary, Alberta, Canada
  326.                                     T3A 2V9
  327.  
  328.     I hope you enjoy the program.  A sample output report follows.
  329.  
  330.                                  Yours truly,
  331.  
  332.                                 R.J. (Bob) Ross
  333.  
  334.  
  335.  
  336.                       ─────── An Example Output ──────
  337.  
  338. Binkley.log                                                    BinkLA V1.05
  339.                                RJ's Byteline BBS
  340.                    Binkley Log Statistics for the period of
  341.                22 Sep 03:06:29 Hrs «« to »» 22 Sep 15:54:30 Hrs
  342. ┌──────────────────┬────────────────────────────────────┬──────────────────┐
  343. │░░░░░░░░░░░░░░░░░░│ Part I - Message Transfers & Calls │░░░░░░░░░░░░░░░░░░│
  344. ╞══════════════╤═══╧════════════════╤═══════════════════╧═════╤══════╤═════╡
  345. │Zone:Net/Node │   Telephone Calls  │       Message Bytes     │  CPS │ Tran│
  346. │    Number    │ Out │ Connect │ In │ Outgoing   │  Incoming  │  Avg │  Min│
  347. ╞══════════════╧═════╧═════════╧════╧════════════╧════════════╧══════╧═════╡
  348. │1:100/555         3      1       0           0        11,100    925    0.2│
  349. │1:134/0           0      3       3           0         3,433    490    0.1│
  350. │1:134/1           2      1       0           0       153,748   1618    1.6│
  351. │1:134/2           1      4       3         634        13,567    710    0.3│
  352. │1:30124/1         0      4       4     173,027           630   1046    2.8│
  353. ├──────────────────────────────────────────────────────────────────────────┤
  354. │ TOTALS           6     13      10     173,661       182,478   1187    5.0│
  355. ╘══════════════════════════════════════════════════════════════════════════╛
  356.  
  357. ┌───────────────────┬──────────────────────────────────┬───────────────────┐
  358. │░░░░░░░░░░░░░░░░░░░│ PART II - Network File Transfers │░░░░░░░░░░░░░░░░░░░│
  359. ╞══════════════╤════╧═══════════════╤══════════════════╧══════╤══════╤═════╡
  360. │Zone:Net/Node │                    │       File Bytes        │  CPS │ Tran│
  361. │    Number    │     File Names     │ Outgoing   │  Incoming  │ Rate │  Min│
  362. ╞══════════════╧════════════════════╧════════════╧════════════╧══════╧═════╡
  363. │1:100/555          0064022B.REQ             12             0      6    0.0│
  364. │1:100/555          QBNWS203.ZIP              0       111,984   1027    1.8│
  365. ├──────────────────────────────────────────────────────────────────────────┤
  366. │ TOTALS                2                    12       111,984   1009    1.9│
  367. ╘══════════════════════════════════════════════════════════════════════════╛
  368.  
  369. ┌───────────────────┬──────────────────────────────────┬───────────────────┐
  370. │░░░░░░░░░░░░░░░░░░░│ PART III - Network Session Costs │░░░░░░░░░░░░░░░░░░░│
  371. ╞══════════════╤════╧═══════════════╤══════════════════╧══════╤════════════╡
  372. │Zone:Net/Node │     Logged At      │       Session Time      │    Cost    │
  373. │    Number    │  Date  │   Time    │     Hrs │ Mins │ Secs   │            │
  374. ╞══════════════╧════════╧═══════════╧═════════╧══════╧════════╧════════════╡
  375. │1:100/555       22 Sep   07:36:59        00     02     56       $  0.60   │
  376. ╘══════════════════════════════════════════════════════════════════════════╛
  377.  
  378. ┌──────────────────────────┬────────────────────┬──────────────────────────┐
  379. │░░░░░░░░░░░░░░░░░░░░░░░░░░│ PART  IV - SUMMARY │░░░░░░░░░░░░░░░░░░░░░░░░░░│
  380. ╞══════════════════════════╧════╤═══════════════╧══════════════════════════╡
  381. │ BBS Callers at  9600   =    0 │ Message Bytes Transferred    =   356,139 │
  382. │                 2400   =    4 │ File Bytes Transferred       =   111,996 │
  383. │                 1200   =    1 │ TOTAL Bytes Transferred      =   468,135 │
  384. │                 Other  =    0 ├──────────────────────────────────────────┤
  385. │                               │ Message Connect Time         =       0.1 │
  386. │ TOTAL BBS Callers      =    5 │ File Transfer Connect Time   =       0.0 │
  387. │                               │ TOTAL Connect Time (Hours)   =       0.1 │
  388. │                               │ TOTAL Network Session Costs  =   $  0.60 │
  389. │                               ├──────────────────────────────────────────┤
  390. │                               │ Unsuccessful Connect Attempts=         3 │
  391. └───────────────────────────────┴──────────────────────────────────────────┘
  392.  
  393.                         Created Data File: BKLARPT.DAT
  394.  
  395.  
  396. Sample BKLARPT.DAT
  397.  
  398. 1,100,555,3,1,0,0,11100,925,12
  399. 1,134,0,0,3,3,0,3433,490.4286,7
  400. 1,134,1,2,1,0,0,153748,1618.4,95
  401. 1,134,2,1,4,3,634,13567,710.05,20
  402. 1,30124,1,0,4,4,173027,630,1046.126,166
  403.  
  404.  
  405.